/*
 * Copyright 2025 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.springframework.data.rest.webmvc.json;

import org.springframework.core.MethodParameter;
import org.springframework.data.domain.Sort;
import org.springframework.web.context.request.NativeWebRequest;

/**
 * Functional interface to translate a {@link Sort} object based on the current input and web request in the context of
 * a {@link MethodParameter}.
 *
 * @author Mark Paluch
 * @since 5.0
 */
@FunctionalInterface
public interface SortTranslator {

	/**
	 * Translate the given {@link Sort} object based on the current input and web request.
	 *
	 * @param input
	 * @param parameter
	 * @param webRequest
	 * @return translated sort.
	 */
	Sort translateSort(Sort input, MethodParameter parameter, NativeWebRequest webRequest);

}
